Base class for Kanzi nodes. More...
#include <kanzi/core.ui/node/node.hpp>
Classes | |
| class | MessageSubscriptionToken |
| Message subscription token for nodes. More... | |
| struct | NodeComponentEntry |
| Object node component entry. More... | |
Public Member Functions | |
| ResourceSharedPtr | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. | |
| ResourceManager::AcquireTaskSharedPtr | acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const |
| Posts an asynchronous task to acquire a resource. | |
| ResourceDictionarySharedPtr | acquireResourceDictionary () |
| Gets a resource dictionary of a node. | |
| virtual bool | addAbstractChildOverride (NodeSharedPtr child)=0 |
| void | addAnonymousResource (ResourceSharedPtr resource) |
| Adds alias resource to an object node. | |
| void | addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator) |
| Transfers the ownership and attaches an input manipulator to an object node. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message handler where the handler is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message handler where the handler is a method that is invoked on an object. | |
| void | addNodeComponent (NodeComponentSharedPtr nodeComponent) |
| Transfers the ownership of a node component to an object node. | |
| void | addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner) |
| Transfers the ownership of a node component to an object node and sets the owner of the node component. | |
| void | addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference) |
| void | addResource (const ResourceID &resourceId, string_view resourceUrl) |
| Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. | |
| void | addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Adds a nested resource dictionary to the resource dictionary of a node. | |
| void | addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| AppliedStyleEntrySharedPtr | applyManualStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| AppliedStyleEntrySharedPtr | applyStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| void | applyStyles () |
| Apply all styles for an object node. | |
| void | applyStylesRecursive () |
| Applies styles recursively. | |
| void | attachRecursive () |
| Attaches an object node and its children recursively. | |
| InputManipulatorConstIterator | beginInputManipulators () const |
| NodeComponentConstIterator | beginNodeComponents () const |
| void | clearChangeFlag (uint32_t flag) |
| Clears a change flag. | |
| void | clearChildChangeFlag (uint32_t flag) |
| Clears a child change flag. | |
| bool | containsResource (const ResourceID &resourceID) const |
| Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. | |
| BindingLookupContextPtr | createLookupContext (NodeSharedPtr templateRoot) |
| Creates a lookup context for the node. | |
| void | detachRecursive () |
| Detaches a node and its descendants. | |
| void | dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| template<typename TArgumentsType > | |
| void | dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| InputManipulatorConstIterator | endInputManipulators () const |
| NodeComponentConstIterator | endNodeComponents () const |
| template<typename TNodeType > | |
| shared_ptr< TNodeType > | findAbstractChild (string_view name) |
| Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. | |
| optional< string > | findResourceURL (const ResourceID &resourceId) const |
| Tries to find Resource URL for Resource ID from this node. | |
| virtual size_t | getAbstractChildCountOverride ()=0 |
| virtual size_t | getAbstractChildIndexOverride (const Node &node)=0 |
| virtual NodeSharedPtr | getAbstractChildOverride (size_t index)=0 |
| template<typename DataType > | |
| DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| uint32_t | getChangeFlags () const |
| Get current change flags. | |
| uint32_t | getChildChangeFlags () const |
| Get current child change flags. | |
| FocusManager * | getFocusManager () const |
| Returns the Focus Manager associated with the Screen node to which this node belongs. | |
| FocusScope * | getFocusScopeInfo () const |
| Returns the information about the focus scope for a node. | |
| InputManager * | getInputManager () const |
| Returns the Input Manager associated with the Screen node to which this node belongs. | |
| AbstractPropertyTypeDescriptor::ValueSource * | getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::DataType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| Node * | getParent () const |
| Returns the parent of the node. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property. | |
| ResourceDictionarySharedPtr | getResourceDictionary () const |
| If a node has a resource dictionary, returns the resource dictionary of that node. | |
| Screen * | getScreen () const |
| Returns the Screen node to which this node belongs. | |
| NodeSharedPtr | getTemplateRoot () const |
| Gets the template root of this node. | |
| void | invalidateArrange () |
| Invalidates arrange. | |
| void | invalidateDraw () |
| Invalidates draw flag for the node. | |
| void | invalidateFinalTransform () |
| Invalidates final transform for node. | |
| void | invalidateMeasure () |
| Invalidates measure for the node. | |
| void | invalidateRender () |
| Invalidates render for node. | |
| bool | isAnyChangeFlagSet (uint32_t flag) const |
| Checks if any of given flags is set. | |
| bool | isAnyChildChangeFlagSet (uint32_t flag) const |
| Checks if any child change flags (corresponding to given mask) are set. | |
| bool | isAttached () const |
| Returns true if the node is attached to a screen or one of its descendants. | |
| bool | isAttaching () const |
| Returns true if node is in the process of attaching, false otherwise. | |
| bool | isChangeFlagSet (uint32_t flag) const |
| Checks if a change flag is set. | |
| bool | isChildChangeFlagSet (uint32_t flag) const |
| Checks if child change flags match. | |
| bool | isDetaching () const |
| Returns true if the node currently detaching. | |
| bool | isEffectivelyFocusable () const |
| Returns whether a node is focusable. | |
| bool | isEffectivelyVisible () const |
| Returns whether a node and its ancestor nodes are visible. | |
| bool | isInitialized () const |
| Returns true if initialize() has been called, false otherwise. | |
| bool | isInvalidArrange () const |
| Checks if the node needs arrange. | |
| bool | isInvalidDraw () |
| Tells if node draw flag is invalid. | |
| bool | isInvalidFinalTransform () const |
| Tells if final transform flag is invalid for node. | |
| bool | isInvalidMeasure () const |
| Check if the node needs measure. | |
| bool | isInvalidRender () const |
| Returns if node render flag is invalid. | |
| bool | isNamed (string_view name) const |
| KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty) | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNode (string_view pathOrKey) |
| Returns a node of specified type by looking it up with specified path or alias. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNodeComponent (string_view name) |
| Returns a node component of specified type by looking it up with specified name. | |
| Node * | lookupNodeRaw (string_view relativePath) |
| Get an object node by another node and a relative path. | |
| ObjectSharedPtr | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| tuple< NodeSharedPtr, AbstractPropertyType > | lookupObjectForStateManager (string_view relativePath) |
| Lookup for an node and possible object from within the node for state manager. | |
| virtual bool | moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index)=0 |
| Moves a child node to a given position in the list of child nodes. | |
| void | notifyResourceDictionaryModified () |
| Forces the re-evaluation of resource IDs in a node tree. | |
| virtual bool | removeAbstractChildOverride (Node &child)=0 |
| void | removeAnonymousResource (const Resource &resource) |
| Removes anonymous resource from object node resources. | |
| void | removeInputManipulator (InputManipulator &inputManipulator) |
| Removes the ownership and detaches an input manipulator from an object node. | |
| void | removeKZBData () |
| Destroys all object node data loaded from KZB. | |
| void | removeKZBData (flat_set< AbstractPropertyType > *keepProperties) |
| Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. | |
| void | removeMessageHandler (MessageSubscriptionToken token) |
| Removes a message subscription. | |
| void | removeNodeComponent (NodeComponent &nodeComponent) |
| Removes the ownership of a node component from an object node. | |
| void | removeNodeComponentWithOwner (const void *owner) |
| Removes all bindings with the specified owner. | |
| void | removeNodeReference (const AbstractNodeReference &reference) |
| void | removeResource (const ResourceID &resourceId) |
| Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. | |
| void | removeResourceReference (const AbstractResourceReference &reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| virtual void | restoreResources () |
| Reattaches an object node after potential resource change. | |
| void | setChangeFlag (uint32_t flag) |
| Sets a change flag. | |
| void | setChildChangeFlag (uint32_t flag) |
| Sets a child change flag. | |
| void | setParent (Node *parent) |
| Kanzi uses this method internally to set the parent of a node. | |
| void | setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Replaces the resource dictionary of a node. | |
| void | setScreen (Screen *screen) |
| Sets the Screen node to which this node belongs. | |
| void | setTemplateRoot (NodeSharedPtr templateRoot) |
| Sets the template root of this node. | |
| ResourceSharedPtr | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. | |
| KZ_DEPRECATED NodeSharedPtr | trySetActiveFocus () |
| Tries to move the focus on this node. | |
| NodeSharedPtr | trySetFocus () |
| Tries to move the focus to this node. | |
| NodeSharedPtr | trySetFocus (FocusFallback fallbackOption) |
| Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. | |
| void | unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| Unapplies a style from an object node. | |
| void | unapplyStyles () |
| Unapplies and removes all applied styles. | |
| void | unapplyStylesRecursive () |
| Unapplies styles recursively. | |
| void | validateArrange () |
| Validates arrange. | |
| void | validateDraw () |
| Validates draw flags for the node. | |
| void | validateDrawForChildrenRecursive () |
| Recursively validates draw for the children from this 2D node onwards. | |
| void | validateMeasure () |
| Validates measure for the node. | |
| void | validateRender () |
| Validates render for node. | |
| VisitorResult | visit (const Visitor &visitor, VisitorOrder order) |
| Visits a node and its descendants. | |
| VisitorResult | visitDescendants (const Visitor &visitor, VisitorOrder order) |
| Visits the descendants of a node. | |
| ~Node () override | |
| Destructor. | |
 Public Member Functions inherited from kanzi::Object | |
| AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object. | |
| void | applyObjectStyles () |
| Apply all styles for an object node. | |
| Domain * | getDomain () const |
| Returns the domain the object belongs to. | |
| const Metaclass * | getDynamicMetaclass () const override |
| Returns the metaclass of the dynamic type of the object. | |
| MainLoopScheduler * | getMainLoopScheduler () const |
| Returns the MainLoopScheduler instance of the associated Domain. | |
| detail::MessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object. | |
| ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object. | |
| ScriptingContextSharedPtr | getScriptingContext () const |
| Gets the scripting context of the object. | |
| Object (Domain *domain) | |
| void | setScriptingContext (ScriptingContextSharedPtr context) |
| Sets the scripting context of the object. | |
| void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| void | unapplyObjectStyles () |
| Unapplies and removes all applied styles. | |
| ~Object () override | |
| Public Member Functions inherited from kanzi::MetaObject | |
| bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it. | |
| virtual | ~MetaObject () |
| Public Member Functions inherited from kanzi::PropertyObject | |
| template<typename DataType > | |
| void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| Adds a property modifier without notifying handlers. | |
| template<typename DataType > | |
| void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| PropertyStorageContainer::iterator | beginPropertyStorage () |
| Returns the begin iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| Returns the begin iterator to the internal property storage container. | |
| void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| Copies local value of single property from another object. | |
| void | copyLocalValues (const PropertyObject &other) |
| Copies all local values from another object. | |
| PropertyStorageContainer::iterator | endPropertyStorage () |
| Returns the end iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| Returns the end iterator to the internal property storage container. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property type. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers. | |
| template<typename DataType > | |
| size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| Gets number of current notification handlers for given property type. | |
| bool | hasBaseValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value, disregarding modifiers. | |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property. | |
| bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a value of any precedence higher than class default value set for the property. | |
| bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value. | |
| bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
| PropertyObject () | |
| void | removeKzbProperties () |
| Remove all KZB properties. | |
| void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| Remove all KZB properties that are not included in a given set. | |
| template<typename DataType > | |
| void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property. | |
| template<typename DataType > | |
| void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| template<typename DataType > | |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| template<typename DataType > | |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| Sets the local value of a property type. | |
| void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| virtual | ~PropertyObject () |
| Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node > | |
| void | addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner) |
| Adds an already-created binding runtime to this binding host. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Sets a binding to a certain property. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Sets a modifier binding. | |
| Public Member Functions inherited from kanzi::BindingHostConcept | |
| BindingRuntimeConstIterator | beginBindingRuntimes () const |
| Returns an iterator to the beginning of binding runtimes. | |
| BindingRuntimeConstIterator | endBindingRuntimes () const |
| Returns an iterator to the end of binding runtimes. | |
| AbstractBindingRuntimeSharedPtr | getBindingRuntime (size_t idx) |
| Gets binding by index. | |
| size_t | getBindingRuntimeCount () const |
| Gets the number of binding runtimes added to this node. | |
| void | removeAllBindings () |
| Removes all binding runtimes. | |
| void | removeBinding (BindingRuntimeHandle &bindingRuntime) |
| Removes a binding runtime added earlier. | |
| void | removeBindingsWithOwner (shared_ptr< void > owner) |
| Removes all binding runtimes with the specified owner. | |
Static Public Member Functions | |
| static bool | isUnboundedLayoutValue (float layoutValue) |
| Indicates whether a value is an unbound layout value. | |
| static bool | isValidLayoutValue (float value) |
| Indicates whether a value is valid layout value. | |
| static float | replaceUnboundedLayoutValue (float layoutValue, float resetValue) |
| Replaces layout value with the specified value if it is unbounded and returns it. | |
| static float | replaceUnboundedLayoutValueWithZero (float layoutValue) |
| Replaces layout value with zero if it is unbounded layout value and returns it. | |
| static float | unboundedLayoutValue () |
| Returns an unbounded layout value. | |
| Static Public Member Functions inherited from kanzi::Object | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
| Static Public Member Functions inherited from kanzi::MetaObject | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
Static Protected Member Functions | |
| static VisitorResult | applyStylesVisitor (Node &node, bool apply) |
| static VisitorResult | attachVisitor (Node &node) |
| static VisitorResult | detachVisitor (Node &node) |
| static bool | processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason) |
| Processes notification handlers for node and property storage. | |
| static VisitorResult | propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason) |
| static VisitorResult | updateAllResourcesVisitor (Node &node) |
| static VisitorResult | updateResourceVisitor (Node &node, const ResourceID &id) |
| static VisitorResult | validateDrawVisitor (Node &node) |
| Visitor for validating draw. | |
Friends | |
| class | InputManager |
Additional Inherited Members | |
| Protected Types inherited from kanzi::Object | |
| typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
| Applied style container. | |
| Protected Attributes inherited from kanzi::Object | |
| AppliedStyleContainer | m_appliedStyles |
| Listing of applied styles applied to this object. | |
| Protected Attributes inherited from kanzi::BindingHostConcept | |
| BindingRuntimeContainer | m_bindingRuntimes |
| Bindings in this object. | |
Detailed Description
Base class for Kanzi nodes.
Kanzi messages
Use the interface provided by Node to dispatch messages and enable the nodes in the node tree to react to messages.
When you dispatch a message it travels in two phases: first tunneling, then bubbling. During the tunneling phase the message travels from the root node to the node where the message originated. From there the message bubbles back to the root node.
When you want a node to react to a message when that message passes, add message handlers or filters to those nodes. A message filter intercepts messages from any node while a message handler listens only to messages from a specific source node. To register message handlers and filters that react to:
- Bubbling messages use Node::addMessageHandler() and Node::addMessageFilter()
- Tunneling messages use Node::addTunnelingHandler() and Node::addTunnelingFilter()
To remove all types of handlers and filters use Node::removeMessageHandler().
To dispatch a single message, use Node::dispatchMessage().
Examples
To define a simple example node, one message type, two callbacks which are suitable for message handlers and a counting mechanism to verify the callback invocations:
To add a handler that consumes the messages sent by the node itself with Node::addMessageHandler():
To remove the handler with Node::removeMessageHandler():
To add a bubbling handler with Node::addMessageHandler():
To remove a bubbling handler with Node::removeMessageHandler():
To add a tunneling filter with Node::addTunnelingFilter():
To remove a tunneling filter with Node::removeMessageHandler():
To dispatch a message use Node::dispatchMessage():
Property types
Examples
To set node properties:
To introduce new message types and use them:
Member Typedef Documentation
◆ MessageSubscriptionTokenVector
◆ Visitor
| typedef function<VisitorResult(Node&) kanzi::Node::Visitor) |
Defines the type of the function that Kanzi executes for each node when visiting a node tree.
◆ InputManipulatorContainer
Gets the input manipulator iterator.
◆ InputManipulatorIterator
| typedef InputManipulatorContainer::iterator kanzi::Node::InputManipulatorIterator |
◆ InputManipulatorConstIterator
| typedef InputManipulatorContainer::const_iterator kanzi::Node::InputManipulatorConstIterator |
◆ NodeComponentContainer
Gets the node component iterator.
◆ NodeComponentIterator
| typedef NodeComponentContainer::iterator kanzi::Node::NodeComponentIterator |
◆ NodeComponentConstIterator
| typedef NodeComponentContainer::const_iterator kanzi::Node::NodeComponentConstIterator |
Member Enumeration Documentation
◆ HorizontalAlignment
◆ VerticalAlignment
◆ DepthAlignment
◆ ContentStretch
Content stretch option.
◆ VisitorOrder
Defines the order in which Kanzi visits the nodes in a node tree.
◆ VisitorResult
Defines the return type of the Node::Visitor function.
- See also
- Node::Visitor, visit(), visitDescendants()
Constructor & Destructor Documentation
◆ ~Node()
|
override |
Destructor.
◆ Node()
|
explicitprotected |
Constructor.
Member Function Documentation
◆ getName()
|
inline |
Gets the value of NameProperty.
- See also
- setName()
◆ setName()
|
inline |
Sets the value of NameProperty.
- See also
- getName()
◆ getPath()
|
inline |
Gets the value of PathProperty.
- See also
- setPath()
◆ setPath()
|
inline |
Sets the value of PathProperty.
- See also
- getPath()
◆ getLocale()
|
inline |
Gets the value of LocaleProperty.
- See also
- setLocale()
◆ setLocale()
|
inline |
Sets the value of LocaleProperty.
- See also
- getLocale()
◆ isHitTestable()
|
inline |
Gets the value of HitTestableProperty.
- See also
- setHitTestable()
◆ setHitTestable()
Sets the value of HitTestableProperty.
- See also
- isHitTestable()
◆ isHitTestableContainer()
|
inline |
Gets the value of HitTestableContainerProperty.
- See also
- setHitTestableContainer()
◆ setHitTestableContainer()
Sets the value of HitTestableContainerProperty.
- See also
- isHitTestableContainer()
◆ isVisible()
|
inline |
Gets the value of VisibleProperty.
- See also
- setVisible()
◆ setVisible()
Sets the value of VisibleProperty.
- See also
- isVisible()
◆ isEnabled()
|
inline |
Returns the value of the EnabledProperty.
- See also
- setEnabled()
◆ setEnabled()
Sets the value of the EnabledProperty.
- See also
- isEnabled()
◆ isEffectivelyEnabled()
|
inline |
Returns the value of EffectivelyEnabledProperty.
- Since
- Kanzi 3.9.0
◆ isFocusable()
|
inline |
Gets the value of the FocusableProperty.
- See also
- setFocusable()
◆ setFocusable()
Sets the value of the FocusableProperty.
- Parameters
-
value To enable a node to get focus and participate in focus chain navigation, set to true, otherwise false.
- See also
- isFocusable()
◆ isFocused()
|
inline |
Gets the value of the FocusedProperty.
- See also
- setFocused()
◆ setFocused()
Sets the value of the FocusedProperty.
- Parameters
-
value To set focus, set to true. To clear focus, set to false.
- See also
- isFocused(), FocusManager::trySetFocus()
◆ getFocusState()
|
inline |
◆ setFocusState()
|
inline |
◆ getFontFamily()
| FontFamilySharedPtr kanzi::Node::getFontFamily | ( | ) | const |
◆ setFontFamily()
| void kanzi::Node::setFontFamily | ( | FontFamilySharedPtr | value | ) |
◆ getVisibleAmountInParent()
|
inline |
Gets the value of VisibleAmountInParentProperty.
- See also
- setVisibleAmountInParent()
◆ setVisibleAmountInParent()
Sets the value of VisibleAmountInParentProperty.
- See also
- getVisibleAmountInParent()
◆ getProjection2DTo3DScale()
|
inline |
Gets the value of Projection2DTo3DScaleProperty.
- See also
- setProjection2DTo3DScale()
◆ setProjection2DTo3DScale()
Sets the value of Projection2DTo3DScaleProperty.
- See also
- getProjection2DTo3DScale()
◆ getStyle()
|
inline |
Gets the value of StyleProperty.
- See also
- setStyle()
◆ setStyle()
|
inline |
Sets the value of StyleProperty.
- See also
- getStyle()
◆ getStateManager()
|
inline |
Gets the value of StateManagerProperty.
- See also
- setStateManager()
◆ setStateManager()
|
inline |
Sets the value of StateManagerProperty.
- See also
- getStateManager()
◆ getWidth()
|
inline |
Gets the value of WidthProperty.
- See also
- setWidth()
◆ setWidth()
Sets the value of WidthProperty.
- See also
- getWidth()
◆ getHeight()
|
inline |
Gets the value of HeightProperty.
- See also
- setHeight()
◆ setHeight()
Sets the value of HeightProperty.
- See also
- getHeight()
◆ getDepth()
|
inline |
Gets the value of DepthProperty.
- See also
- setDepth()
◆ setDepth()
Sets the value of DepthProperty.
- See also
- getDepth()
◆ getActualWidth()
|
inline |
Gets the value of ActualWidthProperty.
- See also
- setActualWidth()
◆ setActualWidth()
Sets the value of ActualWidthProperty.
- See also
- getActualWidth()
◆ getActualHeight()
|
inline |
Gets the value of ActualHeightProperty.
- See also
- setActualHeight()
◆ setActualHeight()
Sets the value of ActualHeightProperty.
- See also
- getActualHeight()
◆ getActualDepth()
|
inline |
Gets the value of ActualDepthProperty.
- See also
- setActualDepth()
◆ setActualDepth()
Sets the value of ActualDepthProperty.
- See also
- getActualDepth()
◆ getHorizontalAlignment()
|
inline |
Gets the value of HorizontalAlignmentProperty.
- See also
- setHorizontalAlignment()
◆ setHorizontalAlignment()
|
inline |
Sets the value of HorizontalAlignmentProperty.
- See also
- getHorizontalAlignment()
◆ getVerticalAlignment()
|
inline |
Gets the value of VerticalAlignmentProperty.
- See also
- setVerticalAlignment()
◆ setVerticalAlignment()
|
inline |
Sets the value of VerticalAlignmentProperty.
- See also
- getVerticalAlignment()
◆ getDepthAlignment()
|
inline |
Gets the value of DepthAlignmentProperty.
- See also
- setDepthAlignment()
◆ setDepthAlignment()
|
inline |
Sets the value of DepthAlignmentProperty.
- See also
- getDepthAlignment()
◆ getHorizontalMargin()
|
inline |
Gets the value of HorizontalMarginProperty.
- See also
- setHorizontalMargin()
◆ setHorizontalMargin()
Sets the value of HorizontalMarginProperty.
- See also
- getHorizontalMargin()
◆ getVerticalMargin()
|
inline |
Gets the value of VerticalMarginProperty.
- See also
- setVerticalMargin()
◆ setVerticalMargin()
Sets the value of VerticalMarginProperty.
- See also
- getVerticalMargin()
◆ getDepthMargin()
|
inline |
Gets the value of DepthMarginProperty.
- See also
- setDepthMargin()
◆ setDepthMargin()
Sets the value of DepthMarginProperty.
- See also
- getDepthMargin()
◆ getContentStretch()
|
inline |
Gets the value of ContentStretchProperty.
- See also
- setContentStretch()
◆ setContentStretch()
|
inline |
Sets the value of ContentStretchProperty.
- See also
- getContentStretch()
◆ getOpacity()
|
inline |
Gets the value of OpacityProperty.
- See also
- setOpacity()
◆ setOpacity()
Sets the value of OpacityProperty.
- See also
- getOpacity()
◆ isHover()
|
inline |
Returns whether the node has HoverProperty set to true.
- Returns
- If the HoverProperty is set to true, true, otherwise false.
◆ isClipChildren()
|
inline |
Gets the value of ClipChildrenProperty.
- See also
- setClipChildren()
◆ setClipChildren()
Sets the value of ClipChildrenProperty.
- See also
- isClipChildren()
◆ KZ_METACLASS_PROPERTY_TYPE()
| kanzi::Node::KZ_METACLASS_PROPERTY_TYPE | ( | FontFamilyProperty | ) |
◆ getProperty()
|
inline |
Returns the current value of a property.
The value returned by this function is the result of the property system evaluating the inputs that can affect the values of properties. The final value is calculated by determining the base value of the property and applying existing modifiers to it.
Base value is affected by the following inputs where the highest entry in the list determines the base value:
- Local value set with setProperty or loaded from kzb
- Value set by a style affecting the property.
- Value defined by class metadata.
When the base value is determined the system applies modifiers to the value that can change the value or replace it completely. The following is the list of possible modifiers, where the order of evaluation is determined by the order the modifiers were added or applied.
- Values defined is states of state manager.
- Animations.
If the property metadata specifies that the property is inheritable and no inputs for the property value can be determined at the current node the system iterates the node tree to the root until inputs are found or the root is reached.
If no inputs to the property value can be established the system returns the value registered in the property type metadata.
- Parameters
-
propertyType The property type identifying the property to retrieve.
- Returns
- Returns the evaluated property value.
◆ getNodeFinalValueSource()
|
inline |
◆ getOptionalProperty()
|
inline |
Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
- Parameters
-
propertyType The property type identifying the property to retrieve.
- Returns
- Returns true if there are inputs into the property value, false otherwise.
◆ getAbstractProperty()
| DataType kanzi::Node::getAbstractProperty | ( | AbstractPropertyType | abstractPropertyType | ) | const |
◆ getOptionalAbstractProperty()
| optional< typename PropertyType< DataType >::DataType > kanzi::Node::getOptionalAbstractProperty | ( | AbstractPropertyType | abstractPropertyType | ) | const |
◆ addMessageHandler() [1/3]
| MessageSubscriptionToken kanzi::Node::addMessageHandler | ( | TMessageType & | messageType, |
| TClass * | messageHandlerObject, | ||
| TClassMethod | method ) |
Adds a message handler where the handler is a method that is invoked on an object.
The handler is invoked when a message of messageType is signaled in the node the handler is added to.
- Parameters
-
messageType The message type to listen to. messageHandlerObject The object that owns the method. A shared pointer must own this object. method The method invoked when the node that owns the handler receives a matching message. The source of the message has to be the node itself.
- Returns
- The MessageSubscriptionToken which identifies the added handler.
◆ addMessageFilter() [1/2]
| MessageSubscriptionToken kanzi::Node::addMessageFilter | ( | TMessageType & | messageType, |
| TClass * | messageHandlerObject, | ||
| TClassMethod | method ) |
Adds a message filter where the filter is a method that is invoked on an object.
The filter is invoked when a message of messageType bubbles through the node the filter is added to.
- Parameters
-
messageType The message type to listen to. messageHandlerObject The object that owns the method. A shared pointer must own this object. method The method invoked when the node that owns the filter receives a matching message.
- Returns
- The MessageSubscriptionToken which identifies the added filter.
◆ addMessageHandler() [2/3]
| MessageSubscriptionToken kanzi::Node::addMessageHandler | ( | const TMessageType & | messageType, |
| typename TMessageType::FunctionType | function ) |
Adds a message handler where the handler is a function.
The handler is invoked when a message of messageType is signaled in the node the handler is added to.
- Parameters
-
messageType The message type to listen to. function The function invoked when the node that owns the handler receives a matching message. The source of the message has to be the node itself.
- Returns
- The MessageSubscriptionToken which identifies the added handler.
◆ addMessageFilter() [2/2]
| MessageSubscriptionToken kanzi::Node::addMessageFilter | ( | const TMessageType & | messageType, |
| typename TMessageType::FunctionType | function ) |
Adds a message filter where the filter is a function.
The filter is invoked when a message of messageType bubbles through the node the filter is added to.
- Parameters
-
messageType The message type to listen to. function The function invoked when the node that owns the filter receives a matching message.
- Returns
- The MessageSubscriptionToken which identifies the added filter.
◆ addMessageHandler() [3/3]
| MessageSubscriptionToken kanzi::Node::addMessageHandler | ( | const TMessageType & | messageType, |
| typename TMessageType::FunctionType | function, | ||
| Node * | messageSourceFilter ) |
Adds a message handler where the handler is a function and you explicitly define the accepted source.
The handler is invoked when a message of messageType bubbles through the node to which you add the handler, but only when you dispatch it from the given source node.
- Parameters
-
messageType The message type to listen to. function The function invoked when the node that owns the handler receives a matching message. messageSourceFilter Source node of the messages.
- Returns
- The MessageSubscriptionToken which identifies the added handler.
◆ addTunnelingHandler()
| MessageSubscriptionToken kanzi::Node::addTunnelingHandler | ( | const TMessageType & | messageType, |
| typename TMessageType::FunctionType | function, | ||
| Node * | messageSourceFilter ) |
Adds a message handler where the handler is a function and you explicitly define the accepted source.
The handler is invoked when a message of messageType tunnels through the node to which you add the handler, but only when you dispatch it from the given source node.
- Parameters
-
messageType The message type to listen to. function The function invoked when the node that owns the handler receives a matching message. messageSourceFilter Source node of the messages.
- Returns
- The MessageSubscriptionToken which identifies the added handler.
◆ addTunnelingFilter() [1/2]
| MessageSubscriptionToken kanzi::Node::addTunnelingFilter | ( | const TMessageType & | messageType, |
| typename TMessageType::FunctionType | function ) |
Adds a message filter where the filter is a function.
The filter is invoked when a message of messageType tunnels through the node to which you add this filter.
- Parameters
-
messageType The message type to listen to. function The function invoked when the node that owns the filter receives a matching message.
- Returns
- The MessageSubscriptionToken which identifies the added filter.
◆ addTunnelingFilter() [2/2]
| MessageSubscriptionToken kanzi::Node::addTunnelingFilter | ( | const TMessageType & | messageType, |
| TClass * | messageHandlerObject, | ||
| TClassMethod | method ) |
Adds a message filter where the filter is a method that is invoked on an object.
The filter is invoked when a message of messageType tunnels through the node to which you add this filter.
- Parameters
-
messageType The message type to listen to. messageHandlerObject The object that owns the method. A shared pointer must own this object. method The method invoked when the node that owns the filter receives a matching message.
- Returns
- The MessageSubscriptionToken which identifies the added filter.
◆ removeMessageHandler()
| void kanzi::Node::removeMessageHandler | ( | MessageSubscriptionToken | token | ) |
Removes a message subscription.
- Parameters
-
token The message subscription token which identifies the handler or filter.
◆ dispatchMessage()
| void kanzi::Node::dispatchMessage | ( | const MessageType< TArgumentsType > & | messageType, |
| typename MessageType< TArgumentsType >::ArgumentsType & | messageArguments ) |
Dispatches a message from this node with specified arguments.
- Parameters
-
messageType The type of the dispatched message. messageArguments The arguments of the dispatched message.
◆ dispatchAbstractMessage()
| void kanzi::Node::dispatchAbstractMessage | ( | const AbstractMessageType & | messageType, |
| MessageArguments & | messageArguments ) |
Dispatches a message from this node with specified arguments.
- Parameters
-
messageType The type of the dispatched message. messageArguments The arguments of the dispatched message.
- Since
- Kanzi 3.8.0
◆ addResource()
| void kanzi::Node::addResource | ( | const ResourceID & | resourceId, |
| string_view | resourceUrl ) |
Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */.
◆ removeResource()
| void kanzi::Node::removeResource | ( | const ResourceID & | resourceId | ) |
Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */.
◆ containsResource()
| bool kanzi::Node::containsResource | ( | const ResourceID & | resourceID | ) | const |
Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */.
◆ findResourceURL()
| optional< string > kanzi::Node::findResourceURL | ( | const ResourceID & | resourceId | ) | const |
◆ acquireResource() [1/2]
| ResourceSharedPtr kanzi::Node::acquireResource | ( | const ResourceID & | id | ) | const |
Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.
If the resource id maps to a resource url, but the url doesn't map to any resource, throws an exception.
- Parameters
-
id Name of the resource.
- Returns
- Shared pointer to the resource, or nullptr if the resource id doesn't map to any resource url.
◆ acquireResource() [2/2]
| shared_ptr< T > kanzi::Node::acquireResource | ( | const ResourceID & | id | ) | const |
Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type.
If the cast fails, or the found resource url doesn't map to a resource, throws an exception.
- Parameters
-
id Name of the resource.
- Returns
- Shared pointer to the resource, or nullptr if the resource id doesn't map to any resource url.
◆ tryAcquireResource() [1/2]
| ResourceSharedPtr kanzi::Node::tryAcquireResource | ( | const ResourceID & | id | ) | const |
Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.
- Parameters
-
id Name of the resource.
- Returns
- Shared pointer to the resource, or nullptr if the resource id or resource url doesn't map to any resource.
◆ acquireResourceAsync()
| ResourceManager::AcquireTaskSharedPtr kanzi::Node::acquireResourceAsync | ( | const ResourceID & | key, |
| ResourceManager::AsyncAcquireFinishedCallback | func ) const |
Posts an asynchronous task to acquire a resource.
- Parameters
-
key Name of the resource. func Callback to execute upon completion of the task.
- Returns
- Task created or an empty shared pointer on failure.
◆ tryAcquireResource() [2/2]
| shared_ptr< T > kanzi::Node::tryAcquireResource | ( | const ResourceID & | id | ) | const |
Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type.
- Parameters
-
id Name of the resource.
- Returns
- Shared pointer to the resource, or nullptr if the resource is not found.
◆ getResourceDictionary()
| ResourceDictionarySharedPtr kanzi::Node::getResourceDictionary | ( | ) | const |
If a node has a resource dictionary, returns the resource dictionary of that node.
- Returns
- The resource dictionary of the node. If the node does not have a resource dictionary, returns nullptr.
◆ acquireResourceDictionary()
| ResourceDictionarySharedPtr kanzi::Node::acquireResourceDictionary | ( | ) |
Gets a resource dictionary of a node.
If a resource dictionary does not exist, the function creates it.
- Returns
- The resource dictionary of the node.
◆ notifyResourceDictionaryModified()
| void kanzi::Node::notifyResourceDictionaryModified | ( | ) |
Forces the re-evaluation of resource IDs in a node tree.
If you modify a resource dictionary of a node that is already attached, you can use this function to update the resource properties. Note that you need to use this function only if you modify the dictionary directly through getResourceDictionary or acquireResourceDictionary. If you use other Node class functions like addResource or setResourceDictionary, you do not need to call this function.
◆ setResourceDictionary()
| void kanzi::Node::setResourceDictionary | ( | ResourceDictionarySharedPtr | resourceDictionary | ) |
Replaces the resource dictionary of a node.
Updates all the resource references of the child nodes.
- Parameters
-
resourceDictionary The resource dictionary.
◆ addResourceDictionary()
| void kanzi::Node::addResourceDictionary | ( | ResourceDictionarySharedPtr | resourceDictionary | ) |
Adds a nested resource dictionary to the resource dictionary of a node.
Updates all the resource references of the child nodes.
- Parameters
-
resourceDictionary The nested resource dictionary.
◆ addAnonymousResource()
| void kanzi::Node::addAnonymousResource | ( | ResourceSharedPtr | resource | ) |
Adds alias resource to an object node.
Removes alias resource from an object node. Adds anonymous resource (such as style) for object node resources.
◆ removeAnonymousResource()
Removes anonymous resource from object node resources.
◆ isNamed()
| bool kanzi::Node::isNamed | ( | string_view | name | ) | const |
◆ getParent()
| Node * kanzi::Node::getParent | ( | ) | const |
Returns the parent of the node.
◆ setParent()
Kanzi uses this method internally to set the parent of a node.
Do not use this method directly to change the parent of a node. Instead, use the addAbstractChildOverride and removeAbstractChildOverride methods from the parent node.
- Parameters
-
parent The parent node to set.
◆ visit()
| VisitorResult kanzi::Node::visit | ( | const Visitor & | visitor, |
| VisitorOrder | order ) |
Visits a node and its descendants.
- Parameters
-
visitor The visitor function to apply for the visited nodes. order The visiting order.
◆ visitDescendants()
| VisitorResult kanzi::Node::visitDescendants | ( | const Visitor & | visitor, |
| VisitorOrder | order ) |
Visits the descendants of a node.
- Parameters
-
visitor The visitor function to apply for the visited nodes. order The visiting order.
◆ lookupNode()
| shared_ptr< Type > kanzi::Node::lookupNode | ( | string_view | pathOrKey | ) |
Returns a node of specified type by looking it up with specified path or alias.
◆ lookupNodeRaw()
| Node * kanzi::Node::lookupNodeRaw | ( | string_view | relativePath | ) |
Get an object node by another node and a relative path.
User should use lookupNode.
- Parameters
-
relativePath Path to use for relative lookup.
- Returns
- Pointer to node.
◆ lookupObject() [1/2]
| ObjectSharedPtr kanzi::Node::lookupObject | ( | string_view | relativePath | ) |
Lookup for an object from a node.
Object found may be another node or a resource within a node.
- Parameters
-
relativePath Relative path to use for lookup.
- Returns
- Shared pointer referencing object. May be empty if no object found.
◆ lookupObjectForStateManager()
| tuple< NodeSharedPtr, AbstractPropertyType > kanzi::Node::lookupObjectForStateManager | ( | string_view | relativePath | ) |
Lookup for an node and possible object from within the node for state manager.
If the path points to a resource within the node, the node, and the associated abstract property type will be returned.
- Parameters
-
relativePath Relative path to use for lookup.
- Returns
- Tuple of node and possibly abstract property type.
◆ lookupObject() [2/2]
|
inline |
Lookup for an object from a node.
Object found may be another node or a resource within a node.
- Parameters
-
relativePath Relative path to use for lookup.
- Returns
- Shared pointer referencing object. May be empty if no object found.
◆ findAbstractChild()
| shared_ptr< TNodeType > kanzi::Node::findAbstractChild | ( | string_view | name | ) |
Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene.
◆ addAbstractChildOverride()
|
pure virtual |
Implemented in kanzi::Node2D, and kanzi::Node3D.
◆ getAbstractChildCountOverride()
|
pure virtual |
Implemented in kanzi::Node2D, kanzi::Node3D, and kanzi::Viewport2D.
◆ getAbstractChildIndexOverride()
Implemented in kanzi::Node2D, kanzi::Node3D, and kanzi::Viewport2D.
◆ getAbstractChildOverride()
|
pure virtual |
Implemented in kanzi::Node2D, kanzi::Node3D, and kanzi::Viewport2D.
◆ removeAbstractChildOverride()
Implemented in kanzi::Node2D, and kanzi::Node3D.
◆ moveAbstractChildToPositionOverride()
|
pure virtual |
Moves a child node to a given position in the list of child nodes.
- Parameters
-
child Child node to reposition. index Position at which to place the child node in the list of child nodes.
- Returns
- If the move was successful, true, otherwise false.
- Since
- Kanzi 3.9.3
Implemented in kanzi::Node2D, and kanzi::Node3D.
◆ addInputManipulator()
| void kanzi::Node::addInputManipulator | ( | InputManipulatorBaseSharedPtr | inputManipulator | ) |
Transfers the ownership and attaches an input manipulator to an object node.
- Parameters
-
inputManipulator The input manipulator to add.
◆ removeInputManipulator()
| void kanzi::Node::removeInputManipulator | ( | InputManipulator & | inputManipulator | ) |
Removes the ownership and detaches an input manipulator from an object node.
- Parameters
-
inputManipulator The input manipulator to remove.
◆ beginInputManipulators()
| InputManipulatorConstIterator kanzi::Node::beginInputManipulators | ( | ) | const |
◆ endInputManipulators()
| InputManipulatorConstIterator kanzi::Node::endInputManipulators | ( | ) | const |
◆ addNodeComponent()
| void kanzi::Node::addNodeComponent | ( | NodeComponentSharedPtr | nodeComponent | ) |
Transfers the ownership of a node component to an object node.
◆ addNodeComponentWithOwner()
| void kanzi::Node::addNodeComponentWithOwner | ( | NodeComponentSharedPtr | nodeComponent, |
| const void * | owner ) |
Transfers the ownership of a node component to an object node and sets the owner of the node component.
◆ removeNodeComponent()
| void kanzi::Node::removeNodeComponent | ( | NodeComponent & | nodeComponent | ) |
Removes the ownership of a node component from an object node.
◆ removeNodeComponentWithOwner()
Removes all bindings with the specified owner.
◆ beginNodeComponents()
| NodeComponentConstIterator kanzi::Node::beginNodeComponents | ( | ) | const |
◆ endNodeComponents()
| NodeComponentConstIterator kanzi::Node::endNodeComponents | ( | ) | const |
◆ lookupNodeComponent()
| shared_ptr< Type > kanzi::Node::lookupNodeComponent | ( | string_view | name | ) |
Returns a node component of specified type by looking it up with specified name.
If name is not specified, then the first anonymous node component of specified type is returned.
◆ isEffectivelyVisible()
| bool kanzi::Node::isEffectivelyVisible | ( | ) | const |
Returns whether a node and its ancestor nodes are visible.
◆ isEffectivelyFocusable()
| bool kanzi::Node::isEffectivelyFocusable | ( | ) | const |
Returns whether a node is focusable.
A node is focusable when it is a focus scope node or has FocusableProperty attached and set to true, or both.
- Returns
- If the node is focusable, returns true, otherwise false.
- Since
- Kanzi 3.7.0
◆ getFocusScopeInfo()
| FocusScope * kanzi::Node::getFocusScopeInfo | ( | ) | const |
Returns the information about the focus scope for a node.
- Returns
- The focus scope information attached to the root node of the focus scope. If the node is not the root of a focus scope, nullptr.
- See also
- FocusScope
- Since
- Kanzi 3.7.0
◆ getChangeFlags()
|
inline |
Get current change flags.
- Returns
- Change flags directly.
◆ getChildChangeFlags()
|
inline |
Get current child change flags.
- Returns
- Child change flags directly.
◆ setChangeFlag()
◆ clearChangeFlag()
◆ isChangeFlagSet()
◆ isAnyChangeFlagSet()
◆ setChildChangeFlag()
◆ clearChildChangeFlag()
◆ isChildChangeFlagSet()
◆ isAnyChildChangeFlagSet()
Checks if any child change flags (corresponding to given mask) are set.
◆ isInvalidMeasure()
| bool kanzi::Node::isInvalidMeasure | ( | ) | const |
Check if the node needs measure.
◆ invalidateMeasure()
| void kanzi::Node::invalidateMeasure | ( | ) |
Invalidates measure for the node.
◆ validateMeasure()
| void kanzi::Node::validateMeasure | ( | ) |
Validates measure for the node.
◆ isInvalidArrange()
| bool kanzi::Node::isInvalidArrange | ( | ) | const |
Checks if the node needs arrange.
◆ invalidateArrange()
| void kanzi::Node::invalidateArrange | ( | ) |
Invalidates arrange.
◆ validateArrange()
| void kanzi::Node::validateArrange | ( | ) |
Validates arrange.
◆ isInvalidRender()
| bool kanzi::Node::isInvalidRender | ( | ) | const |
Returns if node render flag is invalid.
◆ validateRender()
| void kanzi::Node::validateRender | ( | ) |
Validates render for node.
◆ invalidateRender()
| void kanzi::Node::invalidateRender | ( | ) |
Invalidates render for node.
◆ isInvalidFinalTransform()
| bool kanzi::Node::isInvalidFinalTransform | ( | ) | const |
Tells if final transform flag is invalid for node.
◆ invalidateFinalTransform()
| void kanzi::Node::invalidateFinalTransform | ( | ) |
Invalidates final transform for node.
◆ isInvalidDraw()
| bool kanzi::Node::isInvalidDraw | ( | ) |
Tells if node draw flag is invalid.
◆ invalidateDraw()
| void kanzi::Node::invalidateDraw | ( | ) |
Invalidates draw flag for the node.
◆ validateDraw()
| void kanzi::Node::validateDraw | ( | ) |
Validates draw flags for the node.
◆ validateDrawForChildrenRecursive()
| void kanzi::Node::validateDrawForChildrenRecursive | ( | ) |
Recursively validates draw for the children from this 2D node onwards.
Called internally by the system in situations where draw does not otherwise descend to the node.
◆ isInitialized()
| bool kanzi::Node::isInitialized | ( | ) | const |
Returns true if initialize() has been called, false otherwise.
◆ isAttached()
| bool kanzi::Node::isAttached | ( | ) | const |
Returns true if the node is attached to a screen or one of its descendants.
◆ isAttaching()
| bool kanzi::Node::isAttaching | ( | ) | const |
Returns true if node is in the process of attaching, false otherwise.
◆ isDetaching()
| bool kanzi::Node::isDetaching | ( | ) | const |
Returns true if the node currently detaching.
◆ attachRecursive()
| void kanzi::Node::attachRecursive | ( | ) |
Attaches an object node and its children recursively.
- Deprecated
- In Kanzi 3.9.6.
◆ detachRecursive()
| void kanzi::Node::detachRecursive | ( | ) |
Detaches a node and its descendants.
◆ applyStyle()
| AppliedStyleEntrySharedPtr kanzi::Node::applyStyle | ( | StyleSharedPtr | style | ) |
Applies a style to an object node.
Returns a style entry that is used to unapply the style.
◆ applyManualStyle()
| AppliedStyleEntrySharedPtr kanzi::Node::applyManualStyle | ( | StyleSharedPtr | style | ) |
Applies a style to an object node.
Returns a style entry that is used to unapply the style. The style must be unapplied manually.
◆ unapplyStyle()
| void kanzi::Node::unapplyStyle | ( | AppliedStyleEntrySharedPtr | appliedStyleEntry | ) |
Unapplies a style from an object node.
- Parameters
-
appliedStyleEntry Style entry from a style applied earlier.
◆ applyStyles()
| void kanzi::Node::applyStyles | ( | ) |
Apply all styles for an object node.
◆ unapplyStyles()
| void kanzi::Node::unapplyStyles | ( | ) |
Unapplies and removes all applied styles.
◆ applyStylesRecursive()
| void kanzi::Node::applyStylesRecursive | ( | ) |
Applies styles recursively.
◆ unapplyStylesRecursive()
| void kanzi::Node::unapplyStylesRecursive | ( | ) |
Unapplies styles recursively.
◆ removeKZBData() [1/2]
| void kanzi::Node::removeKZBData | ( | flat_set< AbstractPropertyType > * | keepProperties | ) |
Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc.
It is possible to pass a set of properties as input. The local values of those properties will not be removed.
- Parameters
-
keepProperties Set of properties to keep.
◆ removeKZBData() [2/2]
|
inline |
Destroys all object node data loaded from KZB.
All local values of properties will be removed.
◆ addResourceReference()
| void kanzi::Node::addResourceReference | ( | AbstractPropertyType | propertyType, |
| AbstractResourceReference * | reference ) |
This is a helper for automatic resource tracking in ResourceReference.
- Parameters
-
propertyType Property type to listen changes on. reference Reference to react on.
◆ removeResourceReference()
| void kanzi::Node::removeResourceReference | ( | const AbstractResourceReference & | reference | ) |
This is a helper for automatic resource tracking in ResourceReference.
- Parameters
-
reference Reference to remove.
◆ addNodeReference()
| void kanzi::Node::addNodeReference | ( | AbstractPropertyType | propertyType, |
| AbstractNodeReference * | reference ) |
◆ removeNodeReference()
| void kanzi::Node::removeNodeReference | ( | const AbstractNodeReference & | reference | ) |
◆ createLookupContext()
| BindingLookupContextPtr kanzi::Node::createLookupContext | ( | NodeSharedPtr | templateRoot | ) |
Creates a lookup context for the node.
- Parameters
-
templateRoot Template root for the node.
- Returns
- Newly created node lookup context.
◆ restoreResources()
Reattaches an object node after potential resource change.
Reimplemented in kanzi::Node2D, kanzi::ProgressiveRenderingViewport2D, kanzi::Viewport2D, kanzi::TextBlock3D, and kanzi::TextBox3D.
◆ isValidLayoutValue()
Indicates whether a value is valid layout value.
Valid layout value is a non-negative floating point number. Valid layout value can be positive infinity (unbounded layout value).
- Parameters
-
value Value to test if it is unbound layout value.
- Returns
- true if the value if valid layout value, false otherwise.
◆ unboundedLayoutValue()
Returns an unbounded layout value.
- Returns
- Unbounded layout value.
◆ isUnboundedLayoutValue()
Indicates whether a value is an unbound layout value.
- Parameters
-
layoutValue Value to test if it is unbound layout value.
- Returns
- true if the layoutValue is unbound layout value, false otherwise.
◆ replaceUnboundedLayoutValue()
|
inlinestatic |
Replaces layout value with the specified value if it is unbounded and returns it.
- Parameters
-
layoutValue Layout value to test if it is unbounded layout value. resetValue The value which is returned if layoutValue is unbounded layout value.
- Returns
- resetValue if layoutValue is an unbounded layout value, layoutValue otherwise.
◆ replaceUnboundedLayoutValueWithZero()
Replaces layout value with zero if it is unbounded layout value and returns it.
- Parameters
-
layoutValue Layout value to test if it is unbounded layout value.
- Returns
- Zero if layoutValue is an unbounded layout value, layoutValue otherwise.
◆ getTemplateRoot()
|
inline |
Gets the template root of this node.
Template root is used in template root bindings. This is an internal function.
◆ setTemplateRoot()
|
inline |
Sets the template root of this node.
Template root is used in template root bindings. This is an internal function.
◆ trySetActiveFocus()
|
inline |
Tries to move the focus on this node.
If this node is a focus scope node, this method tries to focus the preserved focus of the focus scope, or tries to focus on the first focusable descendant node of this node. This is a convenience function of the FocusManager::trySetFocus(), that uses the node as target node.
- Returns
- If this method successfully moved focus, returns this node or a descendant node of this node. If this method did not move focus, returns nullptr.
- Deprecated
- in Kanzi 3.9.0, use trySetFocus()
◆ trySetFocus() [1/2]
| NodeSharedPtr kanzi::Node::trySetFocus | ( | ) |
Tries to move the focus to this node.
If this node is a focus scope node, this method tries to focus the preserved focus of the focus scope, or tries to focus on the first focusable descendant node of this node. This is a convenience function of the FocusManager::trySetFocus(), that uses the node as target node.
- Returns
- If this method successfully moved focus, returns this node or a descendant node of this node. If this method did not move focus, returns nullptr.
◆ trySetFocus() [2/2]
| NodeSharedPtr kanzi::Node::trySetFocus | ( | FocusFallback | fallbackOption | ) |
Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus.
- Parameters
-
fallbackOption The fallback behavior: - FocusFallback::None to use the behavior of FocusManager::trySetFocus().
- FocusFallback::Overlay to set focus to the root node of the overlay to which newFocusNode belongs. This moves the focus to the last-focused node of that overlay.
- FocusFallback::Parent to move up the node tree and try to set focus to the nearest focusable ancestor node.
- Returns
- The node that has focus.
◆ setScreen()
◆ getScreen()
| Screen * kanzi::Node::getScreen | ( | ) | const |
◆ getInputManager()
| InputManager * kanzi::Node::getInputManager | ( | ) | const |
◆ getFocusManager()
| FocusManager * kanzi::Node::getFocusManager | ( | ) | const |
◆ initialize()
|
protected |
Node-specific initialization.
Since initialization is called with the full knowledge of node type, inheriting classes may statically call the base class function.
◆ onAttached()
Called when an object node becomes attached.
Reimplemented in kanzi::ClickConceptImpl< ContentLayout2D, ListBoxItemContainer2D >, kanzi::ClickConceptImpl< ContentLayout3D, ListBoxItemContainer3D >, kanzi::ClickConceptImpl< Node2D, Button2D >, kanzi::ClickConceptImpl< Node2D, ToggleButton2D >, kanzi::ClickConceptImpl< Node3D, Button3D >, kanzi::ClickConceptImpl< Node3D, ToggleButton3D >, kanzi::Instantiator3D, kanzi::Light, kanzi::Model3D, kanzi::Node2D, kanzi::Node3D, kanzi::ProgressiveRenderingViewport2D, kanzi::Screen, kanzi::Viewport2D, kanzi::Viewport3D, kanzi::ActivityElementImpl< ContentLayout2D, Activity2D >, kanzi::ActivityElementImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ParallelActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout3D, Activity3D >, kanzi::ActivityElementImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ExclusiveActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ParallelActivityHost3D >, kanzi::ListBoxConceptImpl< Node2D, GridListBox2D, GridListBox2DTraits >, kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >, kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >, kanzi::NinePatchImage2D, kanzi::Page, kanzi::PageHost, kanzi::TextBlock2D, kanzi::TextBox2D, kanzi::TextBox3D, and kanzi::TrajectoryListBox3D.
◆ onDetached()
Called when an object node becomes detached.
Reimplemented in kanzi::ClickConceptImpl< ContentLayout2D, ListBoxItemContainer2D >, kanzi::ClickConceptImpl< ContentLayout3D, ListBoxItemContainer3D >, kanzi::ClickConceptImpl< Node2D, Button2D >, kanzi::ClickConceptImpl< Node2D, ToggleButton2D >, kanzi::ClickConceptImpl< Node3D, Button3D >, kanzi::ClickConceptImpl< Node3D, ToggleButton3D >, kanzi::Instantiator3D, kanzi::Model3D, kanzi::Node2D, kanzi::Node3D, kanzi::ProgressiveRenderingViewport2D, kanzi::Screen, kanzi::Viewport2D, kanzi::Viewport3D, kanzi::ActivityElementImpl< ContentLayout2D, Activity2D >, kanzi::ActivityElementImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ParallelActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout3D, Activity3D >, kanzi::ActivityElementImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ExclusiveActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ParallelActivityHost3D >, kanzi::ListBoxConceptImpl< Node2D, GridListBox2D, GridListBox2DTraits >, kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >, kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >, kanzi::TextBoxConceptImpl< Node2D, TextBox2D, TextBox2DTraits >, kanzi::TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >, kanzi::ToggleButtonGroupConceptImpl< Node2D, ToggleButtonGroup2D >, kanzi::ToggleButtonGroupConceptImpl< Node3D, ToggleButtonGroup3D >, kanzi::NinePatchImage2D, kanzi::Page, kanzi::PageHost, kanzi::TextBlock2D, kanzi::TextBlock3D, and kanzi::TextBox3D.
◆ onNodePropertyChanged()
|
protectedvirtual |
Method executed on node property change.
- Parameters
-
propertyType Property that was changed in node. reason Change reason.
Reimplemented in kanzi::ClickConceptImpl< ContentLayout2D, ListBoxItemContainer2D >, kanzi::ClickConceptImpl< ContentLayout3D, ListBoxItemContainer3D >, kanzi::ClickConceptImpl< Node2D, Button2D >, kanzi::ClickConceptImpl< Node2D, ToggleButton2D >, kanzi::ClickConceptImpl< Node3D, Button3D >, kanzi::ClickConceptImpl< Node3D, ToggleButton3D >, kanzi::Instantiator3D, kanzi::Model3D, kanzi::Node2D, kanzi::Node3D, kanzi::Screen, kanzi::Viewport2D, kanzi::Viewport3D, kanzi::ActivityElementImpl< ContentLayout2D, Activity2D >, kanzi::ActivityElementImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ParallelActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout3D, Activity3D >, kanzi::ActivityElementImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ExclusiveActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ParallelActivityHost3D >, kanzi::GridLayoutConceptImpl< Node2D, GridLayout2D >, kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D >, kanzi::ListBoxConceptImpl< Node2D, GridListBox2D, GridListBox2DTraits >, kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >, kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >, kanzi::PrefabViewConceptImpl< Node2D, PrefabView2D >, kanzi::PrefabViewConceptImpl< Node3D, PrefabView3D >, kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >, kanzi::ScrollViewConceptImpl< Node3D, ScrollView3D >, kanzi::TextBlockConceptImpl< Node2D, TextBlock2D >, kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >, kanzi::TextBoxConceptImpl< Node2D, TextBox2D, TextBox2DTraits >, kanzi::TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >, kanzi::ToggleButtonGroupConceptImpl< Node2D, ToggleButtonGroup2D >, kanzi::ToggleButtonGroupConceptImpl< Node3D, ToggleButtonGroup3D >, kanzi::TrajectoryLayoutConceptImpl< Node2D, TrajectoryLayout2D >, kanzi::TrajectoryLayoutConceptImpl< Node3D, TrajectoryLayout3D >, kanzi::GridListBox2D, kanzi::GridListBox3D, kanzi::NinePatchImage2D, kanzi::PageHost, kanzi::TextBlock2D, kanzi::TextBlock3D, kanzi::TextBox2D, kanzi::TextBox3D, and kanzi::TrajectoryListBox3D.
◆ findAbstractChildOverride()
|
protectedpure virtual |
Implemented in kanzi::Node2D, kanzi::Node3D, kanzi::Viewport2D, and kanzi::Viewport3D.
◆ visitAbstractChildOverride()
|
protectedpure virtual |
Implemented in kanzi::Node2D, kanzi::Node3D, kanzi::Viewport2D, and kanzi::Viewport3D.
◆ updateResourceVisitor()
|
staticprotected |
◆ updateAllResourcesVisitor()
|
staticprotected |
◆ applyStylesVisitor()
|
staticprotected |
◆ attachVisitor()
|
staticprotected |
◆ detachVisitor()
|
staticprotected |
◆ validateDrawVisitor()
|
staticprotected |
Visitor for validating draw.
◆ processPropertyChanged()
|
staticprotected |
Processes notification handlers for node and property storage.
- Parameters
-
node Node to invoke change notification on. propertyType Changed property type. nodePropertyStorage Property storage for the node being modified. changedPropertyStorage Property storage actually being changed (not necessarily from node). reason Change reason.
- Returns
- True of node still exists after notification handlers have been changed.
◆ propertyChangedVisitor()
|
staticprotected |
◆ updatePropertiesForConnectedNode()
|
protected |
Invokes property notifications for inherited properties during node tree connections.
◆ updatePropertiesForDisconnectedNode()
Invokes property notifications for inherited properties during node tree disconnections.
◆ updateResourceReferences() [1/2]
|
protected |
◆ updateResourceReferences() [2/2]
|
protected |
◆ updateResourceReferencesRecursive() [1/2]
|
protected |
◆ updateResourceReferencesRecursive() [2/2]
|
protected |
◆ attach()
|
protected |
Attaches the object node.
◆ detach()
|
protected |
Detaches the object node.
◆ updateFocusScopeInfo()
|
protectedvirtual |
Updates the overlay scope information that is attached to the root node of an overlay scope.
- See also
- FocusScope
Reimplemented in kanzi::ListBoxConceptImpl< Node2D, GridListBox2D, GridListBox2DTraits >, kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >, and kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >.
◆ notifyPropertyHandlers()
|
overrideprotectedvirtual |
Notifies all property handlers on a property storage.
Hold a reference to the property storage before you call this function. The notification handlers can otherwise cause the storage to become invalid.
- Parameters
-
storagePtr Pointer to the property storage. reason Reason for the notification.
Reimplemented from kanzi::PropertyObject.
Friends And Related Symbol Documentation
◆ InputManager
|
friend |
Member Data Documentation
◆ NameProperty
|
static |
◆ PathProperty
|
static |
◆ LocaleProperty
|
static |
◆ CreatedFromKZBProperty
|
static |
CreatedFromKZB property.
The default value is false.
- See also
- setCreatedFromKZB(), isCreatedFromKZB()
◆ HitTestableProperty
|
static |
◆ HitTestableContainerProperty
|
static |
HitTestableContainer property.
The default value is false.
◆ VisibleProperty
|
static |
◆ EnabledProperty
|
static |
Sets whether the node is enabled.
When you set the EnabledProperty to false for a node, also its descendant nodes in the same overlay scope are effectively disabled. Effectively disabling a node removes that node from the focus chain and cancels the active input manipulators. Use the EffectivelyEnabledProperty to observe whether a node is effectively enabled. The default value is true.
◆ EffectivelyEnabledProperty
|
static |
Indicates whether the node and its ancestor nodes are enabled.
To enable or disable a node, use the EnabledProperty. Use the EffectivelyEnabledProperty in state managers and bindings to observe whether a node is effectively enabled. When a node is effectively disabled:
- When the node is focused, the node receives key input until the focus moves to another node.
- When the node is not focused, the node is not part of the focus chain and does not receive key input.
The default value is true.
- Since
- Kanzi 3.9.0
◆ FocusableProperty
|
static |
Sets whether a node can get focus and can participate in the focus chain navigation.
When the node is also a focus scope, this property sets whether the scope is a focus fence. The default value is false.
- See also
- setFocusable(), isFocusable()
◆ FocusedProperty
|
static |
Sets whether a node is an focus node and can receive key messages.
In a Kanzi application only one node at a time can have focus. The default value is false.
- See also
- setFocused(), isFocused()
◆ FocusStateProperty
|
static |
Reports the focus state of a focusable node or focus scope node.
To observe whether a node is the key focus node, use isFocused() to get the value of the FocusedProperty.
- See also
- getFocusState(), isFocused()
- Since
- Kanzi 3.9.2
◆ FontFamilyProperty
|
static |
Sets the font family the node uses.
The default value is ResourceSharedPtr().
- See also
- setFontFamily(), getFontFamily()
- Since
- Kanzi 3.8.0
◆ VisibleAmountInParentProperty
|
static |
VisibleAmountInParent property.
The default value is 1.0f.
◆ Projection2DTo3DScaleProperty
|
static |
Projection2DTo3DScale property.
The default value is 0.02f.
◆ StyleProperty
|
static |
◆ StateManagerProperty
|
static |
StateManager property.
The default value is ResourceSharedPtr().
- See also
- setStateManager(), getStateManager()
◆ PrefabTemplateSourceProperty
|
static |
PrefabTemplateSource property.
The default value is 0.
◆ WidthProperty
|
static |
◆ HeightProperty
|
static |
◆ DepthProperty
|
static |
◆ ActualWidthProperty
|
static |
◆ ActualHeightProperty
|
static |
◆ ActualDepthProperty
|
static |
◆ HorizontalAlignmentProperty
|
static |
HorizontalAlignment property.
The default value is Node::HorizontalAlignmentCenter.
◆ VerticalAlignmentProperty
|
static |
VerticalAlignment property.
The default value is Node::VerticalAlignmentCenter.
◆ DepthAlignmentProperty
|
static |
DepthAlignment property.
The default value is Node::DepthAlignmentCenter.
- See also
- setDepthAlignment(), getDepthAlignment()
◆ HorizontalMarginProperty
|
static |
Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
The X component sets the left margin and the Y component sets the right margin. The default value is Vector2(0.0f, 0.0f).
◆ VerticalMarginProperty
|
static |
Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
The X component sets the bottom margin and the Y component sets the top margin. The default value is Vector2(0.0f, 0.0f).
- See also
- setVerticalMargin(), getVerticalMargin()
◆ DepthMarginProperty
|
static |
Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout.
The X component sets the back margin and the Y component sets the front margin. The default value is Vector2(0.0f, 0.0f).
- See also
- setDepthMargin(), getDepthMargin()
◆ ContentStretchProperty
|
static |
ContentStretch property.
The default value is Node::ContentStretchUniform.
- See also
- setContentStretch(), getContentStretch()
◆ OpacityProperty
|
static |
◆ HoverProperty
|
static |
Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor.
Kanzi also sets HoverProperty to true for the all of the ancestors of the foremost hit testable node under the cursor.
- See also
- isHover()
◆ ClipChildrenProperty
|
static |
◆ SceneGraphAddNodeChangeChildFlagsProperty
|
static |
SceneGraphAddNodeChangeChildFlags property.
The default value is PropertyTypeChangeFlagFinalTransformation | PropertyTypeChangeFlagMeasure.
◆ SceneGraphAddNodeChangeParentFlagsProperty
|
static |
SceneGraphAddNodeChangeParentFlags property.
The default value is PropertyTypeChangeFlagMeasure.
◆ SceneGraphRemoveNodeChangeChildFlagsProperty
|
static |
SceneGraphRemoveNodeChangeChildFlags property.
The default value is 0.
◆ SceneGraphRemoveNodeChangeParentFlagsProperty
|
static |
SceneGraphRemoveNodeChangeParentFlags property.
The default value is PropertyTypeChangeFlagMeasure.
The documentation for this class was generated from the following file:
- kanzi/core.ui/node/node.hpp